Skip to main content

FlowDocumentState Properties

An object defining properties for the FlowDocumentState class.

Key

A unique identifier for the workflow step.

Type: string


WorkflowCodeInstance

The workflow code instance associated with the flow object.

Type: IWorkflowCode


CachedDMObjects

The cached document management objects related to the flow object.

Type: IRuntimeDMObjects


TypeCode

The type code associated with the flow object.

Type: WorkflowItemTypeCode
Accepted Values:

NameValue
FlowComment-1
FlowStart10
FlowEnd11
FlowPosition15
FlowAssign21
FlowCompare22
FlowOr24
FlowAnd25
FlowMail26
FlowProfession27
FlowDepartment28
Variable30
FlowScript31
FlowNode33
FlowGroup37
FlowTimer39
FlowTimerStarter40
FlowTimerStopper41
FlowApprovalCancellar42
Pauser44
SubFlowCall51
SubFlowBegin52
SubFlowEnd53
FlowPushNotification54
FlowDocument56
FlowCreateDocument57
FlowDocumentSynchronizer58
FlowStarterPosition59
FlowDocumentState63
FlowUniqueIdCreator65
FlowSetDocumentId66
FlowDeleteDocument67
FlowPDFExport68
FlowXMLExport69
FlowMailSender75
FlowParallel79
FlowContinue80
FlowTrigger81
FlowActionCreator82
FlowDigitallySigning83
FlowGptPrompt84

Name

Name for the workflow step.

Type: string


Documents

Gets or sets the list of documents to be updated.

Type: List<FlowDocumentStateItem>

The Documents property contains a collection of FlowDocumentStateItem objects that represent the documents to be updated. When setting this property, it automatically marks each document item as changed by setting their IsChanged property to true. This property is used to manage multiple documents that need their states updated in a single operation.


AssignerPositionObjectName

Gets or sets the name of the assigner position object.

Type: string

The AssignerPositionObjectName property specifies the name of the position object that is assigned to handle the document state updates. When this property is set, it automatically marks the properties as changed by setting IsChanged to true. This property is used to track which position or role is responsible for managing the document states.


Caption

The caption dictionary representing localized captions for the flow object.

Type: Dictionary<string, string>